Получить список заказов в сервисе «Еда»
Запрос позволяет получить список заказов в сервисе «Еда».
Синтаксис запроса
POST https://b2b-api.go.yandex.ru/integration/2.0/orders/eats/list?limit=<количество заказов>
Заголовки запроса
Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.
Скопировано
X-YaTaxi-Selected-Corp-Client-Id
— ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.
Скопировано
Параметры запроса
Запрос может содержать следующие необязательные параметры:
limit
— количество выводимых заказов. При отсутствии данного параметра возвращается информация о первых 150 заказах.cursor
— отметка запроса (возвращается в теле ответа на предыдущий запрос). Для запроса первой страницы параметр указывать не нужно, для запросов последующих страниц — обязательно
Тело запроса
Данные передаются в теле запроса в формате JSON:
Поле |
Описание |
Формат |
Обязательность |
|
Массив идентификаторов сотрудников, сделавших заказы. |
Массив |
Да |
Описание полей ответа
В ответе могут содержаться следующие поля:
Поле | Описание | Формат |
---|---|---|
cursor |
Отметка текущего запроса. | Строка |
limit |
Максимальное количество возвращаемых записей. | Число |
orders |
Список заказов с их описанием. | Массив объектов |
sorting_order |
Направление сортировки массива заказов (по дате создания заказа). | Строка |
Структура элемента массива orders
:
Поле | Описание | Формат |
---|---|---|
id |
Идентификатор заказа. | Строка |
user_id |
Идентификатор пользователя. | Строка |
status |
Статус заказов. | Строка |
created_at |
Дата и время создания заказа. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm . |
Строка |
closed_at |
Дата и время завершения заказа. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm . |
Строка |
restaurant_name |
Название ресторана. | Строка |
destination_address |
Адрес доставки заказа. | Строка |
restaurant_address |
Реквизиты ресторана. | Массив объектов |
order_calculation |
Состав заказов. | Массив объектов |
final_cost |
Стоимость без НДС. Возвращается только для завершенного заказа. | Строка |
vat |
НДС. Возвращается только для завершенного заказа. | Строка |
cost_with_vat |
Стоимость с НДС. Возвращается только для завершенного заказа. | Строка |
currency |
Валюта. | Строка |
Структура элемента массива restaurant_address
:
Поле | Описание | Формат |
---|---|---|
title |
Название реквизита. | Строка |
value |
Значение реквизита. | Строка |
Структура элемента массива order_calculation
:
Поле | Описание | Формат |
---|---|---|
name |
Название блюда. | Строка |
vat |
НДС. Возвращается только для завершенного заказа. | Строка |
cost_with_vat |
Стоимость с НДС. Возвращается только для завершенного заказа. | Строка |
modifiers |
Дополнения к блюду. | Строка |
count |
Количество. | Строка |
Пример запроса
Первый запрос:
POST https://b2b-api.go.yandex.ru/integration/2.0/orders/eats/list?limit=2
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
{
"user_ids": [
"b201...a4bc"
]
}
Последующие запросы:
POST https://b2b-api.go.yandex.ru/integration/2.0/orders/eats/list?limit=2&cursor=djEg...M3OT
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
{
"user_ids": [
"b201...a4bc"
]
}
Пример ответа
Пример ответа на данный запрос выглядит следующим образом:
{
"cursor": "1676209440.0-230212-6600939",
"limit": 2,
"orders": [
{
"id": "230218-1509473",
"user_id": "b201...a4bc",
"status": "delivered",
"created_at": "2023-02-18T11:42:10+03:00",
"closed_at": "2023-02-18T12:42:45+03:00",
"restaurant_name": "Zotman Pizza",
"destination_address": "Мясницкая улица, 40А",
"restaurant_address": [
{
"title": "Наименование",
"value": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ЗОТМАН ПАРТНЕРС\""
},
{
"title": "ОГРН",
"value": "1207700191874"
},
{
"title": "Адрес",
"value": "123376, 123376 Москва, ул Рочдельская, д 15, стр 32, помещ IV ком 32"
},
{
"title": "Часы работы",
"value": "Пн: 11:00 - 23:00\nВт: 11:00 - 23:00\nСр: 11:00 - 23:00\nЧт: 11:00 - 23:00\nПт: 11:00 - 23:00\nСб: 11:00 - 23:00\nВс: 11:00 - 23:00"
}
],
"order_calculation": [
{
"name": "Цыпленок с песто",
"cost": "590.",
"vat": "118.0000",
"cost_with_vat": "708.0000",
"modifiers": [],
"count": 1
},
{
"name": "Доставка",
"cost": "59.",
"vat": "11.8000",
"cost_with_vat": "70.8000"
}
],
"final_cost": "688.0000",
"vat": "137.6000",
"final_cost_with_vat": "825.6000",
"currency": "RUB"
},
{
"id": "230212-6600939",
"user_id": "b201...a4bc",
"status": "delivered",
"created_at": "2023-02-12T19:44:00+03:00",
"closed_at": "2023-02-12T20:59:54+03:00",
"restaurant_name": "Лепим и варим",
"destination_address": "Мясницкая улица, 40А",
"restaurant_address": [
{
"title": "Наименование",
"value": "Индивидуальный предприниматель Карапетян Эрмине Камоевна"
},
{
"title": "ОГРНИП",
"value": "321508100663111"
}
],
"order_calculation": [
{
"name": "Классика жанра большая порция",
"cost": "430.",
"vat": "86.0000",
"cost_with_vat": "516.0000",
"modifiers": [],
"count": 1
},
{
"name": "Доставка",
"cost": "223.",
"vat": "44.6000",
"cost_with_vat": "267.6000"
}
],
"final_cost": "692.0000",
"vat": "138.4000",
"final_cost_with_vat": "830.4000",
"currency": "RUB"
}
],
"sorting_order": "desc"
}
Возможные коды ответа
Ответ на данный запрос может содержать следующие стандартные HTTP-коды:
200
— запрос выполнен успешно.400
— в запросе был передан неизвестный параметр или параметр с недопустимым значением.403
:- SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок
X-YaTaxi-Selected-Corp-Client-Id
(возвращается в случае, если для токена доступно более одного клиента). - SELECTED_CLIENT_ACCESS_DENIED — в заголовке
X-YaTaxi-Selected-Corp-Client-Id
передан ID клиента, к которому нет доступа у этого логина.
- SELECT_CLIENT_HEADER_REQUIRED — в запросе не передан заголовок
Скопировано